com.inscoper.nbo.Experimenter¶

Represents the XML element Experimenter. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Experimenter()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(ExperimenterID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ExperimenterID_Type value) Sets the value of the ID attribute.
ExperimenterID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setFirstName(String value, boolean validate) Sets the value of the FirstName attribute.
void	setFirstName(String value) Sets the value of the FirstName attribute.
String	getFirstName() Returns the value of the FirstName attribute.
void	resetFirstName() Resets the FirstName attribute to an unset state.
boolean	hasFirstName() Checks whether the FirstName attribute is present.
void	setMiddleName(String value, boolean validate) Sets the value of the MiddleName attribute.
void	setMiddleName(String value) Sets the value of the MiddleName attribute.
String	getMiddleName() Returns the value of the MiddleName attribute.
void	resetMiddleName() Resets the MiddleName attribute to an unset state.
boolean	hasMiddleName() Checks whether the MiddleName attribute is present.
void	setLastName(String value, boolean validate) Sets the value of the LastName attribute.
void	setLastName(String value) Sets the value of the LastName attribute.
String	getLastName() Returns the value of the LastName attribute.
void	resetLastName() Resets the LastName attribute to an unset state.
boolean	hasLastName() Checks whether the LastName attribute is present.
void	setEmail(String value, boolean validate) Sets the value of the Email attribute.
void	setEmail(String value) Sets the value of the Email attribute.
String	getEmail() Returns the value of the Email attribute.
void	resetEmail() Resets the Email attribute to an unset state.
boolean	hasEmail() Checks whether the Email attribute is present.
void	setInstitution(String value, boolean validate) Sets the value of the Institution attribute.
void	setInstitution(String value) Sets the value of the Institution attribute.
String	getInstitution() Returns the value of the Institution attribute.
void	resetInstitution() Resets the Institution attribute to an unset state.
boolean	hasInstitution() Checks whether the Institution attribute is present.
void	setUserName(String value, boolean validate) Sets the value of the UserName attribute.
void	setUserName(String value) Sets the value of the UserName attribute.
String	getUserName() Returns the value of the UserName attribute.
void	resetUserName() Resets the UserName attribute to an unset state.
boolean	hasUserName() Checks whether the UserName attribute is present.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
Experimenter	__internal_create(long cPtr, boolean own)
Experimenter	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getFirstNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getMiddleNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getLastNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getEmailAllowedValues() Returns the allowed values for this attribut.
StringSet	getInstitutionAllowedValues() Returns the allowed values for this attribut.
StringSet	getUserNameAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Experimenter(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Experimenter obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Experimenter;

Represents the XML element Experimenter.

This element describes a person who performed an imaging experiment. This person may also be a user of the OME system, in which case the UserName element contains their login name.Experimenters may belong to one or more groups which are specified using one or more ExperimenterGroupRef elements.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Experimenter¶

public Experimenter()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    ExperimenterID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setID¶

public void setID(
    ExperimenterID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getID¶

public ExperimenterID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFirstName¶

public void setFirstName(
    String value,
    boolean validate
)

Sets the value of the FirstName attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setFirstName¶

public void setFirstName(
    String value
)

Sets the value of the FirstName attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getFirstName¶

public String getFirstName()

Returns the value of the FirstName attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetFirstName¶

public void resetFirstName()

Resets the FirstName attribute to an unset state.

No description available in the XSD standard.

function hasFirstName¶

public boolean hasFirstName()

Checks whether the FirstName attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setMiddleName¶

public void setMiddleName(
    String value,
    boolean validate
)

Sets the value of the MiddleName attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setMiddleName¶

public void setMiddleName(
    String value
)

Sets the value of the MiddleName attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMiddleName¶

public String getMiddleName()

Returns the value of the MiddleName attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMiddleName¶

public void resetMiddleName()

Resets the MiddleName attribute to an unset state.

No description available in the XSD standard.

function hasMiddleName¶

public boolean hasMiddleName()

Checks whether the MiddleName attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setLastName¶

public void setLastName(
    String value,
    boolean validate
)

Sets the value of the LastName attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setLastName¶

public void setLastName(
    String value
)

Sets the value of the LastName attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getLastName¶

public String getLastName()

Returns the value of the LastName attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetLastName¶

public void resetLastName()

Resets the LastName attribute to an unset state.

No description available in the XSD standard.

function hasLastName¶

public boolean hasLastName()

Checks whether the LastName attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setEmail¶

public void setEmail(
    String value,
    boolean validate
)

Sets the value of the Email attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setEmail¶

public void setEmail(
    String value
)

Sets the value of the Email attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getEmail¶

public String getEmail()

Returns the value of the Email attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetEmail¶

public void resetEmail()

Resets the Email attribute to an unset state.

No description available in the XSD standard.

function hasEmail¶

public boolean hasEmail()

Checks whether the Email attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setInstitution¶

public void setInstitution(
    String value,
    boolean validate
)

Sets the value of the Institution attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

function setInstitution¶

public void setInstitution(
    String value
)

Sets the value of the Institution attribute.

Parameters:

value The value to set

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

function getInstitution¶

public String getInstitution()

Returns the value of the Institution attribute.

Return: The value of the attribute

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

function resetInstitution¶

public void resetInstitution()

Resets the Institution attribute to an unset state.

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

function hasInstitution¶

public boolean hasInstitution()

Checks whether the Institution attribute is present.

Return: true if the attribute has been set, false otherwise

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

function setUserName¶

public void setUserName(
    String value,
    boolean validate
)

Sets the value of the UserName attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setUserName¶

public void setUserName(
    String value
)

Sets the value of the UserName attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getUserName¶

public String getUserName()

Returns the value of the UserName attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetUserName¶

public void resetUserName()

Resets the UserName attribute to an unset state.

No description available in the XSD standard.

function hasUserName¶

public boolean hasUserName()

Checks whether the UserName attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value,
    boolean validate
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

No description available in the XSD standard.

function getAnnotationRef_List¶

public AnnotationRefVector getAnnotationRef_List()

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value,
    boolean validate
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAnnotationRef_List¶

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

function __internal_create¶

public static Experimenter __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Experimenter fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getFirstNameAllowedValues¶

public static StringSet getFirstNameAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

function getMiddleNameAllowedValues¶

public static StringSet getMiddleNameAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

function getLastNameAllowedValues¶

public static StringSet getLastNameAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

function getEmailAllowedValues¶

public static StringSet getEmailAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

function getInstitutionAllowedValues¶

public static StringSet getInstitutionAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

function getUserNameAllowedValues¶

public static StringSet getUserNameAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

Protected Functions Documentation¶

function Experimenter¶

protected Experimenter(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr¶

protected static long getCPtr(
    Experimenter obj
)

Updated on 2026-06-22 at 17:06:25 +0200